Create 2.0 documentation #39
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
C-Achard
added
documentation
Add initial documentation site for the DeepLabCut Live GUI: new MyST/Jupyter Book config (myst.yml, _toc.yml), site assets (logo, custom.css), top-level docs (index.md, quickstart/install.md), and a build log (_build/logs/myst.build.json). Rename existing camera docs into docs/cameras_backends/ to better organize backends. Also add a "docs" extra to pyproject.toml (jupyter-book>=2.0) to support building the docs.
Introduce a new user guide overview (docs/user_guide/overview.md) that documents the main window, typical workflow, camera/inference/recording controls, stats, menus, and configuration persistence. Add the corresponding startup screenshot (docs/_static/images/main_window/main_window_startup.png) and update docs/myst.yml to surface the new "User Guide → Overview" page in the table of contents.
Add .github/workflows/docs.yml to deploy the repository's Jupyter Book site to GitHub Pages. The workflow (generated by `jupyter-book init --gh-pages`) runs on pushes to main, sets BASE_URL to the repo name, configures Pages permissions and concurrency, installs jupyter-book via npm, builds the HTML site, uploads the build artifact, and deploys using the Pages actions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DLC-Live-GUI docs
Documentation for the GUI based on Jupyter Book 2, targeted for #37.
NOTE
This early draft is currently very barebones/minimal and mostly AI-generated from the main window code.
A TODO list will be added in increasing priority order listing progress of the docs.
This pull request introduces initial documentation and configuration for the DeepLabCut Live GUI project, focusing on user-facing guides, improved documentation structure, and support for building and deploying docs with Jupyter Book and MyST. It also adds custom styling for the documentation and minor clarifications in the application codebase.
Documentation infrastructure and configuration:
.github/workflows/docs.ymlto automate documentation build and deployment to GitHub Pages using Jupyter Book and MyST, enabling continuous documentation updates.docs/myst.ymlto configure the documentation site, navigation structure, project metadata, and custom styling.pyproject.tomlto include adocsextra for installing Jupyter Book, supporting local documentation builds.User documentation:
docs/index.md,docs/quickstart/install.md, anddocs/user_guide/overview.md, covering installation, workflow, main window, and key concepts for non-developer users. [1] [2] [3]Documentation appearance and UX:
docs/_static/custom.cssfor custom header and code block styling, improving readability and visual consistency in both light and dark modes.Minor codebase clarification:
dlclivegui/gui/main_window.pyto better describe error timing related to camera validation during window teardown.